Skip to content

[Contributor Docs:] Document password validation guidance#32201

Open
WodansSon wants to merge 1 commit intomainfrom
docs/password-validation
Open

[Contributor Docs:] Document password validation guidance#32201
WodansSon wants to merge 1 commit intomainfrom
docs/password-validation

Conversation

@WodansSon
Copy link
Copy Markdown
Collaborator

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This PR updates the contributor documentation to clarify how password validation should be handled in the provider.

The goal is to make it clearer that password validation should follow the contract of the specific Azure service or resource, rather than assuming that all password fields across the provider can share one universal validator.

This PR also documents:

  • when contributors should reuse an existing validator
  • when a shared validator makes sense for a resource family
  • where shared validators should normally live in the repo
  • why acceptance tests should prefer fixed known-valid passwords over randomly generated values

The changes are documentation-only and affect:

  • contributing/topics/schema-design-considerations.md
  • contributing/topics/reference-acceptance-testing.md

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them.
  • I have written new tests for my resource or datasource changes & updated any relevant documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass.

This is a documentation-only change. No tests were run.

Change Log

No changelog entry required for contributor documentation updates.

Related Issue(s)

N/A

AI Assistance Disclosure

  • AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

AI assistance was used to draft and refine the contributor documentation changes.

Rollback Plan

If this change needs to be reverted, revert the contributor documentation updates in:

  • contributing/topics/schema-design-considerations.md
  • contributing/topics/reference-acceptance-testing.md

Changes to Security Controls

No changes to security controls.

Copy link
Copy Markdown
Collaborator

@gerrytan gerrytan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @WodansSon , looks good to me

@katbyte katbyte removed the ready label Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants